@vue/compiler-dom

What is @vue/compiler-dom?

The @vue/compiler-dom package is part of the Vue.js ecosystem, specifically designed for compiling Vue template syntax into render functions directly in the browser or on the server. It is a core utility for Vue's template compilation, enabling developers to pre-compile templates or compile them on the fly, optimizing performance and enhancing the development experience with Vue.js applications.

What are @vue/compiler-dom's main functionalities?

Compiling Template Strings

This feature allows developers to compile Vue template strings into render functions. The compiled code can then be used to render Vue components dynamically. This is particularly useful for applications that need to compile templates on the fly, such as those that receive template code from a server.

import { compile } from '@vue/compiler-dom';
const { code } = compile('<div>{{ message }}</div>');
console.log(code);

Parsing Template Options

The package provides functionality to parse template strings into Abstract Syntax Trees (ASTs). This is useful for tools and libraries that need to analyze or manipulate Vue templates at a syntactic level, enabling advanced use cases like static analysis, linting, and custom transformations.

import { parse, baseParse } from '@vue/compiler-dom';
const ast = baseParse('<div>{{ message }}</div>');
console.log(ast);

Transforming AST Nodes

After parsing a template into an AST, @vue/compiler-dom allows developers to apply transformations to the AST nodes. This feature is powerful for creating custom directives or modifying the behavior of existing ones, enabling a high degree of customization and optimization for Vue applications.

import { transform } from '@vue/compiler-dom';
transform(ast, {
  nodeTransforms: [/* array of node transform functions */]
});

Other packages similar to @vue/compiler-dom

babel-plugin-transform-vue-jsx

This package is a Babel plugin that transforms JSX syntax into Vue render functions. While it serves a similar purpose to @vue/compiler-dom by enabling developers to write Vue components using JSX, it operates within the Babel ecosystem and requires a build step, unlike @vue/compiler-dom which can compile templates on the fly.

vue-template-compiler

Part of the Vue 2 ecosystem, this package compiles Vue 2 templates into render functions. It is similar to @vue/compiler-dom but is specifically tailored for Vue 2, whereas @vue/compiler-dom is designed for Vue 3. The vue-template-compiler package is essential for Vue 2 development, offering compatibility with Vue 2's reactivity system and component structure.

README

@vue/compiler-dom

Changelog

3.5.13 (2024-11-15)

Bug Fixes

• compiler-core: handle v-memo + v-for with functional key (#12014) (99009ee), closes #12013
• compiler-dom: properly stringify template string style (#12392) (2d78539), closes #12391
• custom-element: avoid triggering mutationObserver when relecting props (352bc88), closes #12214 #12215
• deps: update dependency postcss to ^8.4.48 (#12356) (b5ff930)
• hydration: the component vnode's el should be updated when a mismatch occurs. (#12255) (a20a4cb), closes #12253
• reactiivty: avoid unnecessary watcher effect removal from inactive scope (2193284), closes #5783 #5806
• reactivity: release nested effects/scopes on effect scope stop (#12373) (bee2f5e), closes #12370
• runtime-dom: set css vars before user onMounted hooks (2d5c5e2), closes #11533
• runtime-dom: set css vars on update to handle child forcing reflow in onMount (#11561) (c4312f9)
• ssr: avoid updating subtree of async component if it is resolved (#12363) (da7ad5e), closes #12362
• ssr: ensure v-text updates correctly with custom directives in SSR output (#12311) (1f75d4e), closes #12309
• ssr: handle initial selected state for select with v-model + v-for option (#12399) (4f8d807), closes #12395
• teleport: handle deferred teleport update before mounted (#12168) (8bff142), closes #12161
• templateRef: set ref on cached async component which wrapped in KeepAlive (#12290) (983eb50), closes #4999 #5004
• test: update snapshot (#12169) (828d4a4)
• Transition: fix transition memory leak edge case (#12182) (660132d), closes #12181
• transition: reflow before leave-active class after leave-from (#12288) (4b479db), closes #2593
• types: defineEmits w/ interface declaration (#12343) (1022eab), closes #8457
• v-once: setting hasOnce to current block only when in v-once (#12374) (37300fc), closes #12371

Performance Improvements

• reactivity: do not track inner key `__v_skip`` (#11690) (d637bd6)
• runtime-core: use feature flag for call to resolveMergedOptions (#12163) (1755ac0)